/*
 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.tools;

import java.io.IOException;
import java.util.Iterator;
import java.util.Set;

import javax.tools.JavaFileObject.Kind;

/**
 * Forwards calls to a given file manager. Subclasses of this class might
 * override some of these methods and might also provide additional fields and
 * methods.
 * 
 * @param <M>
 *            the kind of file manager forwarded to by this object
 * @author Peter von der Ah&eacute;
 * @since 1.6
 */
public class ForwardingJavaFileManager<M extends JavaFileManager> implements
		JavaFileManager {

	/**
	 * The file manager which all methods are delegated to.
	 */
	protected final M fileManager;

	/**
	 * Creates a new instance of ForwardingJavaFileManager.
	 * 
	 * @param fileManager
	 *            delegate to this file manager
	 */
	protected ForwardingJavaFileManager(M fileManager) {
		fileManager.getClass(); // null check
		this.fileManager = fileManager;
	}

	/**
	 * @throws SecurityException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public ClassLoader getClassLoader(Location location) {
		return fileManager.getClassLoader(location);
	}

	/**
	 * @throws IOException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public Iterable<JavaFileObject> list(Location location, String packageName,
			Set<Kind> kinds, boolean recurse) throws IOException {
		return fileManager.list(location, packageName, kinds, recurse);
	}

	/**
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public String inferBinaryName(Location location, JavaFileObject file) {
		return fileManager.inferBinaryName(location, file);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 */
	public boolean isSameFile(FileObject a, FileObject b) {
		return fileManager.isSameFile(a, b);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public boolean handleOption(String current, Iterator<String> remaining) {
		return fileManager.handleOption(current, remaining);
	}

	public boolean hasLocation(Location location) {
		return fileManager.hasLocation(location);
	}

	public int isSupportedOption(String option) {
		return fileManager.isSupportedOption(option);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public JavaFileObject getJavaFileForInput(Location location,
			String className, Kind kind) throws IOException {
		return fileManager.getJavaFileForInput(location, className, kind);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public JavaFileObject getJavaFileForOutput(Location location,
			String className, Kind kind, FileObject sibling) throws IOException {
		return fileManager.getJavaFileForOutput(location, className, kind,
				sibling);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public FileObject getFileForInput(Location location, String packageName,
			String relativeName) throws IOException {
		return fileManager.getFileForInput(location, packageName, relativeName);
	}

	/**
	 * @throws IllegalArgumentException
	 *             {@inheritDoc}
	 * @throws IllegalStateException
	 *             {@inheritDoc}
	 */
	public FileObject getFileForOutput(Location location, String packageName,
			String relativeName, FileObject sibling) throws IOException {
		return fileManager.getFileForOutput(location, packageName,
				relativeName, sibling);
	}

	public void flush() throws IOException {
		fileManager.flush();
	}

	public void close() throws IOException {
		fileManager.close();
	}
}
